Change the Parent Folder of a content item
{ changeItemFolder }
Change the parent folder of a given content item or folder.
Method
/API3/content/changeItemFolder
- Enterprise Admin
Input Parameters
Name
itemParentApiData
Object Type
Description
The item-parent object used to set the content item's parent item ID.
Output Response
Successful Result Code
200
Response Type
Description of Response Type
Generic API response object with success or failure flag and related messages.
Notes
Effectively moves a content item (or folder) from its existing folder to a different parent folder
Code Snippets
Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.
TypeScript
Curl
Java
C#
Python
PHP
curl -X POST \
-H "paToken: [[apiKey]]" \
-H "Accept: application/json,application/json;charset=utf-8,text/plain,text/plain;charset=utf-8" \
-H "Content-Type: application/json" \
"http://Your.Server.URL/API3/content/changeItemFolder" \
-d '{
"itemId" : "itemId",
"parentId" : "parentId"
}'
import com.pyramidanalytics.*;
import com.pyramidanalytics.auth.*;
import com.pyramidanalytics.model.*;
import com.pyramidanalytics.api.ContentServiceApi;
import java.util.*;
import java.time.*;
public class ContentServiceApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("http://Your.Server.URL/");
// Configure API key authorization: paToken
ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
paToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//paToken.setApiKeyPrefix("Token");
// Create an instance of the API class
ContentServiceApi apiInstance = new ContentServiceApi();
// Initialize the itemParentApiData parameter object for the call
ItemParentApiData itemParentApiData = ; // Create the input object for the operation, type: ItemParentApiData
try {
ModifiedItemsResult result = apiInstance.changeItemFolder(itemParentApiData);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ContentServiceApi#changeItemFolder");
e.printStackTrace();
}
}
}
import * as PyramidAnalyticsWebApi from "com.pyramidanalytics";
// Create an instance of the API class
const api = new PyramidAnalyticsWebApi.ContentServiceApi("http://Your.Server.URL")
// Configure API key authorization: paToken
api.setApiToken("YOUR API KEY");
const itemParentApiData = ; // {ItemParentApiData}
api.changeItemFolder(itemParentApiData).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
using System;
using System.Diagnostics;
using PyramidAnalytics.Sdk.Api;
using PyramidAnalytics.Sdk.Client;
using PyramidAnalytics.Sdk.Model;
public class changeItemFolderExample
{
public static void Main()
{
Configuration conf = new Configuration();
conf.BasePath = "http://Your.Server.URL/";
// Configure API key authorization: paToken
conf.ApiKey.Add("paToken", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// conf.ApiKeyPrefix.Add("paToken", "Bearer");
GlobalConfiguration.Instance = conf;
// Create an instance of the API class
var apiInstance = new ContentServiceApi();
// Initialize the itemParentApiData parameter object for the call
var itemParentApiData = new ItemParentApiData(); // ItemParentApiData |
try {
// Change the parent folder of a given content item or folder.
ModifiedItemsResult result = apiInstance.changeItemFolder(itemParentApiData);
Debug.WriteLine(result);
} catch (Exception e) {
Debug.Print("Exception when calling ContentServiceApi.changeItemFolder: " + e.Message );
}
}
}
import com.pyramidanalytics
from com.pyramidanalytics import ApiException
from com.pyramidanalytics import ContentServiceApi
from pprint import pprint
# Configure API key authorization: paToken
api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })
with com.pyramidanalytics.ApiClient(api_config) as api_client:
# Create an instance of the API class
api_instance = ContentServiceApi(api_client)
# Initialize the itemParentApiData parameter object for the call
itemParentApiData = # ItemParentApiData |
try:
# Change the parent folder of a given content item or folder.
api_response = api_instance.change_item_folder(itemParentApiData)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentServiceApi->changeItemFolder: %s\n" % e)
<?php
require_once(__DIR__ . '/vendor/autoload.php');
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');
// Configure API key authorization: paToken
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');
// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ContentServiceApi();
$itemParentApiData = ; // ItemParentApiData |
try {
$result = $api_instance->changeItemFolder($itemParentApiData);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ContentServiceApi->changeItemFolder: ', $e->getMessage(), PHP_EOL;
}
?>